Add a separate PaymentSendFailure for idempotency violation #1826
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheBlueMatt
force-pushed
the
2022-10-idempotency-err
branch
from
e86760f
to
34a6c1a
Compare
Codecov ReportBase: 90.79% // Head: 91.27% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47%
==========================================
Files 87 87
Lines 47600 51304 +3704
Branches 47600 51304 +3704
==========================================
+ Hits 43218 46826 +3608
- Misses 4382 4478 +96
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
TheBlueMatt
force-pushed
the
2022-10-idempotency-err
branch
2 times, most recently
from
4d46352
to
5fa0a6b
Compare
|
Rebased after dependent PR merge. |
tnull
reviewed
Nov 7, 2022
TheBlueMatt
force-pushed
the
2022-10-idempotency-err
branch
from
5fa0a6b
to
207374a
Compare
|
CI sad |
valentinewallace
previously approved these changes
Nov 9, 2022
It was pointed out that its quite confusing that `AllFailedRetrySafe` does not allow you to call `retry_payment`, though the documentation on it does specify this. Instead, we simply rename it to `AllFailedResendSafe` to indicate that the action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to idempotency key violation, they need to know that this was the reason as they need to handle the error programmatically differently from other errors. Here we simply add a new `PaymentSendFailure` enum variant for `DuplicatePayment` to allow for that.
TheBlueMatt
force-pushed
the
2022-10-idempotency-err
branch
from
c7c134c
to
fcf73f0
Compare
|
Squashed without further change. |
valentinewallace
approved these changes
Nov 9, 2022
tnull
approved these changes
Nov 16, 2022
| /// for this payment. | ||
| AllFailedResendSafe(Vec<APIError>), | ||
| /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not | ||
| /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via |
There was a problem hiding this comment.
Suggested change
| /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via | |
| /// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via |
There was a problem hiding this comment.
No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).
| PathParameterError(Vec<Result<(), APIError>>), | ||
| /// All paths which were attempted failed to send, with no channel state change taking place. | ||
| /// You can freely retry the payment in full (though you probably want to do so over different | ||
| /// You can freely resend the payment in full (though you probably want to do so over different | ||
| /// paths than the ones selected). |
There was a problem hiding this comment.
Suggested change
| /// paths than the ones selected). | |
| /// paths than the ones previously selected). |
There was a problem hiding this comment.
Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new
PaymentSendFailureenum variant forDuplicatePaymentto allow for that.